milvus-logo
LFAI
< Docs
  • RESTful
    • v1

Insert

Inserts one or more entities into a collection. You can add a maximum of 100 entities at a time. To insert large volumn of data, you are advised to use the bulk-insert API. For details, refer to Data Import.

POST
/v1/vector/insert
Cluster Endpoint

The base URL for this API is in the following format:

http://localhost:19530

export CLUSTER_ENDPOINT="http://localhost:19530"
Parameters
Authorizationstringheaderrequired

The authentication token should be a pair of colon-joined username and password, like username:password.

Example Value: Bearer {{TOKEN}}
Request Bodyapplication/json
dbNamestring

The name of the database.

collectionNamestringrequired

The name of the collection to which entities will be inserted.

partitionNamestring

The name of the partition to which this operation applies.

dataoneOfrequired

An entity object or an array of entity objects. Note that the keys in an entity object should match the collection schema

A single entity, whose structure should match the schema of the target collection.

export TOKEN="root:Milvus"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/insert" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "my_collection",
"data": {
"id": 1,
"vector": [
0.1,
0.2,
0.3,
0.5,
0.6
]
}
}'
export TOKEN="root:Milvus"
curl --request POST \
--url "${CLUSTER_ENDPOINT}/v1/vector/insert" \
--header "Authorization: Bearer ${TOKEN}" \
--header "Content-Type: application/json" \
-d '{
"collectionName": "my_collection",
"data": [
{
"id": 1,
"vector": [
0.1,
0.2,
0.3,
0.5,
0.6
]
},
{
"id": 2,
"vector": [
0.2,
0.3,
0.4,
0.6,
0.7
]
}
]
}'
Responses200 - application/json
codeinteger

Response code.

dataobject

Response payload which is the statistics on the insert results.

insertCountinteger

The number of inserted entities.

insertIdsarray

Response payload which is an array of the IDs of inserted entities.

[]insertIdsstring

The ID of an inserted entity.

Returns an error message.

codeinteger

Response code.

messagestring

Error message.

{
"code": 200,
"data": {
"insertCount": 4,
"insertIds": [
"id1",
"id2"
]
}
}